home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / Tools / ShareMailGiftware / xad_master / xad20 / Docs / xadUnFile.doc < prev    next >
Text File  |  2002-10-27  |  7KB  |  213 lines
  1. NAME
  2.     xadUnFile 1.25
  3.     xadUnFileM 1.25
  4.  
  5. SYNOPSIS
  6.     xadUnFile FROM/A,DEST=DESTDIR,PASSWORD/K,FILE/M,NAMESIZE/K/N,
  7.     FFS=OFS/S,SFS/S,INFO=LIST/S,Q=QUIET/S,AM=ASKMAKEDIR/S,OW=OVERWRITE/S,
  8.     SP=SHOWPROT/S,VERBOSE/S,DARC=DISKARCHIVE/S,ENTRY/K/N,DIMG=DISKIMAGE/S,
  9.     NA=NOABS/S,NC=NOCOMMENT/S,ND=NODATE/S,NE=NOEXTERN/S,NKP=NOKILLPART/S,
  10.     NP=NOPROT/S,NT=NOTREE/S
  11.  
  12.     xadUnFileM FROM/A/M,DEST=DESTDIR/K,PASSWORD/K,FILE/K,NAMESIZE/K/N,
  13.     FFS=OFS/S,SFS/S,INFO=LIST/S,Q=QUIET/S,AM=ASKMAKEDIR/S,OW=OVERWRITE/S,
  14.     SP=SHOWPROT/S,VERBOSE/S,DARC=DISKARCHIVE/S,ENTRY/K/N,DIMG=DISKIMAGE/S,
  15.     NA=NOABS/S,NC=NOCOMMENT/S,ND=NODATE/S,NE=NOEXTERN/S,NKP=NOKILLPART/S,
  16.     NP=NOPROT/S,NT=NOTREE/S
  17.  
  18. DESCRIPTION
  19.     xadUnFile is the master shell tool to extract data from
  20.     file archives.
  21.  
  22.     FROM specifies the file archive that should be handled.
  23.     The xadUnFileM tool can handle splitted archives, when they are
  24.     given in their correct order. Do not give multiple names of
  25.     single archives! You may use patterns with xadUnFileM.
  26.  
  27.     DESTDIR is the destination directory. The directory is created
  28.     when it does not exist (except if ASKMAKEDIR is turned on and
  29.     you select no). There are some dangerous archives using absolute
  30.     path names (e.g. starting with LIBS: or RAM:). xadUnFile archives
  31.     these files to their absolute position (except NOTREE or NOABS is
  32.     used). For xadUnFileM this argument requires the keyword DEST or
  33.     DESTDIR.
  34.  
  35.     PASSWORD can be used to supply a password for unarchiving of
  36.     encrypted archives. This argument requires the keyword PASSWORD.
  37.  
  38.     FILE allows you to select filename(s) (including patterns), which
  39.     should be extracted. When FILE is not given, all files are
  40.     extracted. With FILE only matching files are extracted.
  41.     NOTE: When you do not use NOTREE keyword, the patterns check
  42.     includes checks for directory structure as well.
  43.     For xadUnFileM there are some special rules:
  44.       To pass multiple names, use patterns like (xxx|yyy|zzz), where
  45.       xxx, yyy and zzz are three file names. You cannot pass multiple
  46.       strings like for xadUnFile. And additionally this argument
  47.       requires the keyword FILE.
  48.  
  49.     NAMESIZE allows to specify the maximum size of a filename. This is
  50.     useful as some archives from unix machines have longer filenames
  51.     than the Amiga filesystem allows. Whenever a name is longer than
  52.     the namesize value, you are asked to enter a shorter name. Names
  53.     of directories are truncated without requests.
  54.     FFS or OFS replace NAMESIZE argument and provide a standard length
  55.     of 30 characters, which is the value of our standard file system.
  56.     SFS provide a length of 100 characters, the SmartFilesystem
  57.     standard.
  58.  
  59.     NOEXTERN prohibits the use of external clients for
  60.     recognition purposes.
  61.     
  62.     INFO or LIST prints information about the archive and does not
  63.     do any unarchiving. SHOWPROT turns on display of protection
  64.     information. VERBOSE shows additional information texts, which
  65.     exist for some archivers.
  66.     
  67.     OVERWRITE forces the program to overwrite an already existing
  68.     destination file. Normally you are asked about that.
  69.     
  70.     NOTREE skips all directory names and writes the files directly to
  71.     destination directory.
  72.     
  73.     ASKMAKEDIR forces the program to ask you, if a missing directory
  74.     should be created.
  75.     
  76.     NOCOMMENT prevents setting archived file comments, NOPROT prevents
  77.     setting file protection bits and NODATE prevents setting date
  78.     information. NOCOMMENT also prevents displaying comment lines with
  79.     INFO or LIST keyword.
  80.     
  81.     NOABS prevents creation of absolute path names.
  82.  
  83.     If you specify NOKILLPART keyword, partial or corrupt output files
  84.     no longer are deleted.
  85.  
  86.     The QUIET option turns off the progress report, but also disables
  87.     questions to skip, rename or overwrite files.
  88.  
  89.     The tool allows to extract files from disk images. If you specify
  90.     DISKIMAGE, the input file is handled as disk image (ADF file)
  91.     and not as file archive. If it is an valid Amiga filesytem disk,
  92.     files can be extracted from it. Specifying DISKARCHIVE is like
  93.     DISKIMAGE, but input data is an disk archive, which is dearchived
  94.     before extracting files. If the disk archive has multiple entries,
  95.     you may use ENTRY keyword to specify the wanted entry. When using
  96.     DISKIMAGE, you may specify an device name like DF0: instead of
  97.     a file name. The input data will then be read from the device.
  98.  
  99. EXAMPLES
  100.     Shell> xadUnFile archive.tar RAM:
  101.         Unarchive the tar archive to RAM:
  102.  
  103.     Shell> xadUnFile archive.lha RAM: #?.txt #?.doc Contents
  104.         Unarchive all .txt and .doc file and the file "Contents" of
  105.         lha archive to RAM:
  106.  
  107.     Shell> xadUnFileM archive.lha DEST RAM: FILE (#?.txt|#?.doc|Contents)
  108.         The same call for xadUnFileM
  109.  
  110.     Shell> xadUnFile archive.lha LIST
  111.         Tells information about archive.lha file.
  112.  
  113.     Shell> xadUnFile image.adf DIMG LIST
  114.         Tells information about files in disk image image.adf.
  115.  
  116.     Shell> xadUnFileM archive.lha archive.l[0-9]? LIST
  117.         Tells information about splitted lha archive.
  118.  
  119. HISTORY
  120.     xadUnFile 1.25, xadUnFileM 1.25
  121.     - now aborts for disk I/O errors
  122.  
  123.     xadUnFile 1.24, xadUnFileM 1.24
  124.     - added support for disk input
  125.  
  126.     xadUnFile 1.23, xadUnFileM 1.23
  127.     - shows Unix device info as comment
  128.  
  129.     xadUnFile 1.22, xadUnFileM 1.22
  130.     - the GetInfo function call now has a progress hook
  131.  
  132.     xadUnFile 1.21, xadUnFileM 1.21
  133.     - returns 10 in case an error occured
  134.  
  135.     xadUnFile 1.20, xadUnFileM 1.20
  136.     - bug fixes with multiple filesystem support
  137.  
  138.     xadUnFile 1.19, xadUnFileM 1.19
  139.     - The program uses new V7 feature and scans for multiple filesystems.
  140.  
  141.     xadUnFile 1.18, xadUnFileM 1.18
  142.     - After extraction a short status is reported.
  143.  
  144.     xadUnFile 1.17, xadUnFileM 1.17
  145.     - added support for archives with unknown decrunched size
  146.  
  147.     xadUnFile 1.16, xadUnFileM 1.16
  148.     - bug fixes
  149.  
  150.     xadUnFile 1.15, xadUnFileM 1.15
  151.     - added support for patterns in xadUnFileM
  152.  
  153.     xadUnFile 1.14, xadUnFileM 1.14
  154.     - added DISKARCHIVE, DISKIMAGE and ENTRY parameters
  155.     - bug fixes
  156.  
  157.     xadUnFile 1.13, xadUnFileM 1.13
  158.     - added VERBOSE parameter
  159.  
  160.     xadUnFile 1.12, xadUnFileM 1.12
  161.     - added NOKILLPART parameter
  162.  
  163.     xadUnFile 1.11, xadUnFileM 1.11
  164.     - added SFS parameter
  165.  
  166.     xadUnFile 1.10, xadUnFileM 1.10
  167.     - added NAMESIZE and FFS or OFS parameters
  168.  
  169.     xadUnFile 1.9, xadUnFileM 1.9
  170.     - Now also sets protection bits and comment for directories. The
  171.       date is correct for empty dirs only, as the OS automatically
  172.       updates the date, if something is changed in the directory.
  173.  
  174.     xadUnFile 1.8, xadUnFileM 1.8
  175.     - Also strips "/" or ":" at name start for NOABS option.
  176.  
  177.     xadUnFile 1.7, xadUnFileM 1.7
  178.     - new options SHOWPROT and QUIET
  179.     - normal xadUnFile got back style of 1.4 and the multifile archive
  180.       style has been implemented in the special xadUnFileM tool.
  181.       Splitted archives are very seldom and it is of no use to make the
  182.       shell arguments that complicated for single file archives.
  183.  
  184.     xadUnFile 1.6
  185.     - added multiple input file support and renaming
  186.  
  187.     xadUnFile 1.4
  188.     - no longer aborts when unarchiving failed for one entry
  189.     - added NOABS option and comment display with INFO
  190.  
  191.     xadUnFile 1.3
  192.     - added size output for "group archivers" like LzX
  193.  
  194.     xadUnFile 1.2
  195.     - added output for corrupted files
  196.  
  197.     xadUnFile 1.1
  198.     - added FILE parameter and directory creation
  199.  
  200.     xadUnFile 1.0
  201.     - First public release.
  202.  
  203. COPYRIGHT
  204.     xadUnFile is freely distributable for noncommercial use.
  205.  
  206. AUTHOR
  207.     Dirk Stöcker
  208.     Geschwister-Scholl-Straße 10
  209.     01877 Bischofswerda
  210.     GERMANY
  211.     
  212.     Dirk Stoecker <stoecker@epost.de>
  213.